.TH bxl.sh 1 "" "" "BuildXL User Guide"
.SH NAME
bxl.sh \- Run BuildXL on macOS
.SH SYNOPSIS
.B buildXL
[--buildxl-bin \fIbuildxl-dir\fR]
[--config \fIconfig-dsc-file\fR]
[--symlink-sdks-into \fIsdk-dir\fR]
[--check-kext-log]
[--load-kext | --no-load-kext]
[--cache-config-file \fIfile\fR]
[\fIbuildxl-arguments\fI]
.SH DESCRIPTION
A wrapper script for running BuildXL on macOS.
.SH OPTIONS
.TP
.BI --buildxl-bin " buildxl-dir"
Directory containing BuildXL binaries.  If not specified, defaults to the directory of the bxl.sh script.
.TP
.BI --config " config-dsc-dir"
BuildXL DScript main configuration file of the build (typically named 'config.dsc').  If omitted, no build is executed.
.TP
.BI --symlink-sdks-into " sdk-dir"
When specified, prior to running the build this script creates a symlink inside of the \fIsdk-dir\fR
folder pointing to the Sdk.Transformers folder from \fIbuildxl-dir\fR directory.  This is useful when
the build specification files require the "Transformers" sdk.
.TP
.BI --check-kext-log
When specified, after BuildXL build completes, this script will check the system log for any error messages
reported by BuildXLSandbox.
.TP
.BI --load-kext " | " --no-load-kext
Whether or not to attempt to load BuildXLSandbox kernel extension prior to running the build.  When neither
is specified, the default is not to automatically load BuildXLSandbox.
.TP
.BI --cache-config-file " cache-config-file"
Path to file which specifies characteristics of the cache. If not specified, defaults to 
'DefaultCacheConfig.json' inside the BuildXL binary directory.
.TP
.IB buildxl-arguments
Arbitrary arguments passed down to the BuildXL binary.